<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2rhino.util.vector</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2rhino-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2rhino</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2rhino-module.html">Package&nbsp;py2rhino</a> ::
        <a href="py2rhino.util-module.html">Package&nbsp;util</a> ::
        Module&nbsp;vector
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2rhino.util.vector-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module vector</h1><p class="nomargin-top"><span class="codelink"><a href="py2rhino.util.vector-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#is_parallel_to" class="summary-sig-name">is_parallel_to</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Compares two vectors to see if they are parallel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_parallel_to">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#is_perpendicular_to" class="summary-sig-name">is_perpendicular_to</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Compares two vectors to see if they are perpendicular.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_perpendicular_to">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#is_tiny" class="summary-sig-name">is_tiny</a>(<span class="summary-sig-arg">vector</span>)</span><br />
      Verifies that a vector is very short, or tiny - the x,y,z  elements 
      are less than or equal to 1.0e-12.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_tiny">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#is_zero" class="summary-sig-name">is_zero</a>(<span class="summary-sig-arg">vector</span>)</span><br />
      Verifies that a vector is zero, or tiny - the  x,y,z elements are 
      equal to 0.0.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_zero">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Adds two 3-D vectors.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#add">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#compare" class="summary-sig-name">compare</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Compares two 3-D vectors.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#compare">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#create" class="summary-sig-name">create</a>(<span class="summary-sig-arg">point_1</span>,
        <span class="summary-sig-arg">point_2</span>)</span><br />
      Creates a vector from two 3-D points.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#create">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#cross_product" class="summary-sig-name">cross_product</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Calculates the cross product of two 3-D vectors.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#cross_product">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#divide" class="summary-sig-name">divide</a>(<span class="summary-sig-arg">vector</span>,
        <span class="summary-sig-arg">divide</span>)</span><br />
      Divides a 3-D vectors by a value</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#divide">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#dot_product" class="summary-sig-name">dot_product</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Calculates the dot product of two 3-D vectors.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#dot_product">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#length" class="summary-sig-name">length</a>(<span class="summary-sig-arg">vector</span>)</span><br />
      Returns the length of a 3-D vector.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#length">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#multiply" class="summary-sig-name">multiply</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Multiplies two 3-D vectors.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#multiply">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#reverse" class="summary-sig-name">reverse</a>(<span class="summary-sig-arg">vector</span>)</span><br />
      Reverses the direction of a 3-D vector.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#reverse">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#rotate" class="summary-sig-name">rotate</a>(<span class="summary-sig-arg">vector</span>,
        <span class="summary-sig-arg">angle</span>,
        <span class="summary-sig-arg">axis</span>)</span><br />
      Rotates a 3-D vector.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#rotate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#scale" class="summary-sig-name">scale</a>(<span class="summary-sig-arg">vector</span>,
        <span class="summary-sig-arg">scale</span>)</span><br />
      Scales a 3-D vector.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#subtract" class="summary-sig-name">subtract</a>(<span class="summary-sig-arg">vector_1</span>,
        <span class="summary-sig-arg">vector_2</span>)</span><br />
      Subtracts two 3-D vectors.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#subtract">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#transform" class="summary-sig-name">transform</a>(<span class="summary-sig-arg">vector</span>,
        <span class="summary-sig-arg">xform</span>)</span><br />
      Transforms a 3-D vector.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#transform">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2rhino.util.vector-module.html#unitize" class="summary-sig-name">unitize</a>(<span class="summary-sig-arg">vector</span>)</span><br />
      Unitizes, or normalizes, a 3-D vector.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2rhino.util.vector-pysrc.html#unitize">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="is_parallel_to"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_parallel_to</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_parallel_to">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Compares two vectors to see if they are parallel.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The 3-D vector. vector_2  
    (List of float, Required) - The 3-D vector to compare to.</p>
  <h1 class="heading">Returns</h1>
    <p>number - The result of the comparison if successful. The possible 
    results are as follows: None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: IsVectorParallelTo</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_perpendicular_to"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_perpendicular_to</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_perpendicular_to">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Compares two vectors to see if they are perpendicular.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The 3-D vector. vector_2  
    (List of float, Required) - The 3-D vector to compare to.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True if the vectors are perpendicular, otherwise False. 
    None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: 
    IsVectorPerpendicularTo</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_tiny"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_tiny</span>(<span class="sig-arg">vector</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_tiny">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Verifies that a vector is very short, or tiny - the x,y,z  elements 
  are less than or equal to 1.0e-12.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector to test.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True if the vector is tiny, otherwise False, if 
    successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: IsVectorTiny</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="is_zero"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">is_zero</span>(<span class="sig-arg">vector</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#is_zero">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Verifies that a vector is zero, or tiny - the  x,y,z elements are 
  equal to 0.0.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector to test.</p>
  <h1 class="heading">Returns</h1>
    <p>boolean - True if the vector is zero, otherwise False, if 
    successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: IsVectorZero</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="add"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#add">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds two 3-D vectors.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The 3-D vector to add to. 
    vector_2  (List of float, Required) - The 3-D vector to add.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorAdd</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="compare"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">compare</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#compare">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Compares two 3-D vectors.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The first 3-D vector to 
    compare. vector_2  (List of float, Required) - The second 3-D vector to
    compare.</p>
  <h1 class="heading">Returns</h1>
    <p>None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorCompare</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="create"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">create</span>(<span class="sig-arg">point_1</span>,
        <span class="sig-arg">point_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#create">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Creates a vector from two 3-D points.</p>
  <h1 class="heading">Parameters</h1>
    <p>point_1  (List of float, Required) - The first 3-D point. point_2  
    (List of float, Required) - The second 3-D point.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorCreate</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="cross_product"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">cross_product</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#cross_product">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates the cross product of two 3-D vectors.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The first 3-D vector. vector_2
    (List of float, Required) - The second 3-D vector.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorCrossProduct</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="divide"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">divide</span>(<span class="sig-arg">vector</span>,
        <span class="sig-arg">divide</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#divide">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Divides a 3-D vectors by a value</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector to divide. divide
    (float, Required) - The a non-zero value to divide.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorDivide</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="dot_product"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">dot_product</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#dot_product">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates the dot product of two 3-D vectors.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The first 3-D vector. vector_2
    (List of float, Required) - The second 3-D vector.</p>
  <h1 class="heading">Returns</h1>
    <p>None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorDotProduct</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="length"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">length</span>(<span class="sig-arg">vector</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#length">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the length of a 3-D vector.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector.</p>
  <h1 class="heading">Returns</h1>
    <p>None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorLength</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="multiply"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">multiply</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#multiply">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Multiplies two 3-D vectors.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The first 3-D vector. vector_2
    (List of float, Required) - The second 3-D vector.</p>
  <h1 class="heading">Returns</h1>
    <p>number - The resulting inner (dot) product if successful. None - On 
    error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorMultiply</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="reverse"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reverse</span>(<span class="sig-arg">vector</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#reverse">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reverses the direction of a 3-D vector.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorReverse</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rotate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rotate</span>(<span class="sig-arg">vector</span>,
        <span class="sig-arg">angle</span>,
        <span class="sig-arg">axis</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#rotate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates a 3-D vector.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector. angle  (float, 
    Required) - The rotation angle in degrees. axis  (List of float, 
    Required) - A 3-D vector defining the axis of rotation.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorRotate</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">scale</span>(<span class="sig-arg">vector</span>,
        <span class="sig-arg">scale</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Scales a 3-D vector.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector to scale. scale  
    (float, Required) - The scale factor to apply.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorScale</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="subtract"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">subtract</span>(<span class="sig-arg">vector_1</span>,
        <span class="sig-arg">vector_2</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#subtract">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Subtracts two 3-D vectors.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector_1  (List of float, Required) - The 3-D vector to subtract 
    from. vector_2  (List of float, Required) - The 3-D vector to 
    subtract.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorSubtract</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="transform"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">transform</span>(<span class="sig-arg">vector</span>,
        <span class="sig-arg">xform</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#transform">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Transforms a 3-D vector.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector to transform. 
    xform  (List of float, Required) - A valid 4x4 transformation 
    matrix.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorTransform</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="unitize"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">unitize</span>(<span class="sig-arg">vector</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2rhino.util.vector-pysrc.html#unitize">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Unitizes, or normalizes, a 3-D vector. Note, zero vectors cannot be 
  unitized.</p>
  <h1 class="heading">Parameters</h1>
    <p>vector  (List of float, Required) - The 3-D vector to unitize.</p>
  <h1 class="heading">Returns</h1>
    <p>list - The resulting 3-D vector if successful. None - On error.</p>
  <h1 class="heading">Rhinoscript</h1>
    <p>This function calls the Rhinoscript function: VectorUnitize</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2rhino-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2rhino</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Sep 02 08:00:03 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
